API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

person_prospects

Creates a person_prospects resource.

Creates a person_prospects resource.

Authorizations:
JWT
path Parameters
id
required
string

person_prospects identifier

Request Body schema:
required

The new person_prospects resource

status
required
string <iri-reference>
referencedBy
string or null
employee
string <iri-reference>
internalabbreviation
string or null
type
string or null <iri-reference>
person
required
string <iri-reference>
industry
string or null <iri-reference>
expertise
string or null
neq
integer or null
icriq
integer or null
nbEmployees
required
integer
turnover
required
string
creationDate
required
string <date-time>
distance
required
string
projectType
string or null <iri-reference>
budget
required
string
notes
string or null
competitor
string or null
potential
required
string
owningCorporation
string <iri-reference>
deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customProperties
any

Can contain anything (array, objects, nested objects...).

customData
Array of strings or null
createdAt
string <date-time>
updatedAt
string <date-time>
disabledAt
string or null <date-time>
object (Collection.jsonld)
upload_filename
string
upload_subfolder
string
upload_file
string
upload_file_link
string
internalAbbreviation
string

Get internalabbreviation.

timestamp
string <date-time>

Get createdAt.

upload_Subfolder
string
upload_File
string
upload_File_Link
string

Responses

Request samples

Content type
{
  • "status": "https://example.com/",
  • "referencedBy": "string",
  • "employee": "https://example.com/",
  • "internalabbreviation": "string",
  • "type": "https://example.com/",
  • "person": "https://example.com/",
  • "industry": "https://example.com/",
  • "expertise": "string",
  • "neq": 0,
  • "icriq": 0,
  • "nbEmployees": 0,
  • "turnover": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "distance": "string",
  • "projectType": "https://example.com/",
  • "budget": "string",
  • "notes": "string",
  • "competitor": "string",
  • "potential": "string",
  • "owningCorporation": "https://example.com/",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "entityFiles": { },
  • "upload_filename": "string",
  • "upload_subfolder": "string",
  • "upload_file": "string",
  • "upload_file_link": "string",
  • "internalAbbreviation": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "upload_Subfolder": "string",
  • "upload_File": "string",
  • "upload_File_Link": "string"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "status": {
    },
  • "referencedBy": "string",
  • "employee": {
    },
  • "type": {
    },
  • "person": {
    },
  • "industry": {
    },
  • "expertise": "string",
  • "neq": 0,
  • "icriq": 0,
  • "nbEmployees": 0,
  • "turnover": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "distance": "string",
  • "projectType": {
    },
  • "budget": "string",
  • "notes": "string",
  • "competitor": "string",
  • "potential": "string",
  • "owningCorporation": {
    },
  • "shortcode": "PR",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "internalAbbreviation": "string",
  • "customPropertiesListing": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}